home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1998 May / EnigmA AMIGA RUN 27 (1998)(G.R. Edizioni)(IT)[!][issue 1998-05].iso / earcd / sinclair-ql / pdtk_readme < prev    next >
Text File  |  1998-02-16  |  6KB  |  240 lines
  1. Short:    Freeware BASIC toolkit with many TK2-like commands
  2. Author:   Mark J Swift
  3. Version:  1.12
  4. Uploader: msw@blackpool.ac.uk
  5.  
  6.  
  7. ARCHIVE CONTENTS
  8.  
  9.  PDTK_rext   - the toolkit
  10.  PDTK_asm    - the assembly source
  11.  QDOS_inc    - QDOS includes
  12.  PDTK_readme - this file
  13.  
  14.  
  15. PROGRAM FEATURES
  16.  
  17. * Contains many TK2-like commands
  18. * Source provided
  19. * FREEWARE
  20.  
  21.  
  22. SUPERBASIC KEYWORDS
  23.  
  24. EXTRAS[#<channel>]
  25.  
  26. This procedure lists all SuperBASIC resident extensions to the
  27. specified channel.
  28.  
  29. TOOLKILL
  30.  
  31. This procedure scours the SuperBASIC name table for duplicate
  32. entries. If one is found, TOOLKILL makes sure that the last
  33. entry defined is the one used. Thus it is possible to write a
  34. program that loads a toolkit, issues a TOOLKILL command, and
  35. executes extensions from the toolkit immediately.
  36.  
  37. WHERE(<Name$>)
  38.  
  39. This function returns the address at which an extension is
  40. loaded. If the extension does not exist, the function returns 0
  41.  
  42. PDTK_VER$
  43.  
  44. This function takes no parameters, and returns the version
  45. number of the PDTK toolkit.
  46.  
  47. PDTK_EXT
  48.  
  49. This procedure adds the following keywords to the list of
  50. SuperBASIC commands:
  51.  
  52. RESET
  53.  
  54. This procedure performs a QL RESET.
  55.  
  56. QDOS$
  57.  
  58. This function returns the version number of the QDOS system ROM.
  59.  
  60. SYSBASE
  61.  
  62. This function returns the address of the system variables.
  63.  
  64. FREE_MEM
  65.  
  66. This function returns the amount of memory available to BASIC.
  67.  
  68. ALCHP
  69.  
  70. This function allocates some memory in the common heap, and
  71. returns the address of the allocation.
  72.  
  73. RECHP<Address>
  74.  
  75. This procedure releases memory from the common heap, previously
  76. allocated at the given address by the function ALCHP.
  77.  
  78. CLCHP
  79.  
  80. This procedure releases all memory from the common heap,
  81. previously allocated by the function ALCHP.
  82.  
  83. LRESPR<FileName$>
  84.  
  85. This procedure allocates some memory in the resident procedure
  86. area, loads a toolkit and calls the code.
  87.  
  88. DDLIST[#<chan>]
  89.  
  90. This procedure lists the name of every directory device driver
  91. to the specified channel, or to channel #1 if none is given.
  92.  
  93. DDTEST(<DirectoryDevice$>)
  94.  
  95. This function returns the status of the specified directory
  96. device:
  97.  
  98.    0    device exists
  99.  
  100.   -7    device not found
  101.  
  102. FTEST(<FileName$>)
  103.  
  104. This function returns the status of the specified file:
  105.  
  106.    0    file exists and is not in use
  107.  
  108.   -7    file not found
  109.  
  110.   -9    file in use
  111.  
  112.   -12   bad device name
  113.  
  114. FLEN(#<chan>)  or FLEN(\<FileName$>)
  115.  
  116. This function returns the length of the file specified, or the
  117. length of the file associated with the specified channel.
  118.  
  119. FTYP(#<chan>)  or FTYP(\<FileName$>)
  120.  
  121. This function returns the type of the file specified,  or the
  122. type of the file associated with the specified channel.
  123.  
  124. typical file types are:
  125.  
  126.   0     BASIC, text or document files
  127.  
  128.   1     QL task
  129.  
  130. FDAT(#<chan>)  or FDAT(\<FileName$>)
  131.  
  132. This function returns the dataspace of a QL task. The file can
  133. be specified, or a channel associated with the file.
  134.  
  135. FACCS(#<chan>)  or FACCS(\<FileName$>)
  136.  
  137. This function returns the file access byte
  138.  
  139. FXTRA(#<chan>)  or FXTRA(\<FileName$>)
  140.  
  141. This function returns the files long word of extra information
  142. that is currently unused.
  143.  
  144. SET_FTYP#<chan>,<byte>  or SET_FTYP\<FileName$>,<byte>
  145. SET_FDAT#<chan>,<byte>  or SET_FDAT\<FileName$>,<byte>
  146. SET_FACCS#<chan>,<byte>  or SET_FACCS\<FileName$>,<byte>
  147. SET_FXTRA#<chan>,<long>  or SET_FXTRA\<FileName$>,<long>
  148.  
  149. These Procedures set the relevant information in the files
  150. header area.
  151.  
  152. HEX$(<number>,<bits>)
  153.  
  154. This function returns a HEX string of the given number with a
  155. length equivalent to the specified number of binary bits.
  156.  
  157. HEX(<HexNumber$>)
  158.  
  159. This function converts the given HEX string into decimal format.
  160.  
  161. INTEGER$(<number>)
  162.  
  163. This function takes an integer number and returns the internal
  164. math representation of the number as a two character string.
  165.  
  166. LONGINT$(<number>)
  167.  
  168. This function takes a long integer number and returns the
  169. internal math representation of the number (should QDOS support
  170. long ints) as a four character string.
  171.  
  172. FLOAT$(<number>)
  173.  
  174. This function takes a floating point number and returns the
  175. internal math representation of the number as a six character
  176. string.
  177.  
  178. STRING$(<number>)
  179.  
  180. This function takes a string and returns another string
  181. representing the initial string's internal format. In essence
  182. the function returns the string parameter with two characters
  183. representing string length, appended to its start.
  184.  
  185. STRING%(<string$>)
  186.  
  187. This function takes the internal math representation of an
  188. integer as a two character string, and returns an integer
  189. result.
  190.  
  191. STRINGL(<string$>)
  192.  
  193. This function takes the internal math representation of a long
  194. integer as a four character string, and returns the long integer
  195. as a floating point result.
  196.  
  197. STRINGF(<string$>)
  198.  
  199. This function takes the internal math representation of a
  200. floating point number as a six character string, and returns a
  201. floating point result.
  202.  
  203. CURSEN[#<chan>]
  204.  
  205. This procedure enables the cursor in the CON window of the specified
  206. channel. BASICs' #1 is assumed if no channel is specified.
  207.  
  208. CURDIS[#<chan>]
  209.  
  210. This procedure disables the cursor in the CON window attached to the
  211. specified channel. BASICs' #1 is assumed if no channel is specified.
  212.  
  213. F_TRACE(<functionname$>, <funcparam1>, <funcparam2> ... )
  214.  
  215. This function executes the named SuperBASIC function in TRACE mode,
  216. and passes all other parameters on to the named function. A trace
  217. exception vector must be set up before using this function.
  218.  
  219. P_TRACE <procedurename$>, <procparam1>, <procparam2> ...
  220.  
  221. This procedure executes the named SuperBASIC procedure in TRACE mode,
  222. and passes all other parameters on to the named procedure. A trace
  223. exception vector must be set up before using this procedure.
  224.  
  225. J_TRACE <taskname$>  and J_TRACE_W <taskname$>
  226.  
  227. These two procedures load, then execute a task in TRACE mode. They are
  228. equivalent to the procedures EXEC and EXEC_W except that the TRACE bit
  229. is set before entering the task. A trace exception vector must be set
  230. up before using this procedure.
  231.  
  232.  
  233. CONTACT
  234.  
  235.   post: MARK J SWIFT          e-mail: msw@blackpool.ac.uk
  236.         175 CHURCH STREET
  237.         BLACKPOOL
  238.         LANCS
  239.         FY1 3NX
  240.